<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>VCRReply xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/mbari/vcr/rs422/VCRReply.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> * @(#)VCRReply.java   2009.02.24 at 09:44:55 PST</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> * Copyright 2007 MBARI</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> *</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> * Licensed under the GNU LESSER GENERAL PUBLIC LICENSE, Version 2.1</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> * <a href="http://www.gnu.org/copyleft/lesser.html" target="alexandria_uri">http://www.gnu.org/copyleft/lesser.html</a></em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a name="16" href="#16">16</a>  <em class="jxr_comment"> * limitations under the License.</em>
<a name="17" href="#17">17</a>  <em class="jxr_comment"> */</em>
<a name="18" href="#18">18</a>  
<a name="19" href="#19">19</a>  
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  <em class="jxr_comment">/*<em class="jxr_comment"> Generated by Together */</em></em>
<a name="22" href="#22">22</a>  <strong class="jxr_keyword">package</strong> org.mbari.vcr.rs422;
<a name="23" href="#23">23</a>  
<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> java.util.Arrays;
<a name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> org.mbari.util.NumberUtilities;
<a name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> org.mbari.vcr.IVCRError;
<a name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> org.mbari.vcr.IVCRState;
<a name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> org.mbari.vcr.IVCRTimecode;
<a name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> org.mbari.vcr.IVCRUserbits;
<a name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> org.mbari.vcr.VCRException;
<a name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> org.mbari.vcr.VCRReplyAdapter;
<a name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a name="33" href="#33">33</a>  <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a name="34" href="#34">34</a>  
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment">/**</em>
<a name="36" href="#36">36</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;Use to store replys from a sony VCR. The proper method for using this class is:&lt;/p&gt;</em>
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment"> *</em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment"> * vcrReply.update(command, cmd, data, checksum);</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> * &lt;/pre&gt;</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> *</em>
<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;It will check the checksum value and set the appropriate VCRStatus flags and</em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> * reply errors. If the checksum is bad it will hrow a SonyVCRException&lt;/p&gt;</em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment"> *</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;A reply consists of 3 parts. The first part is the cmd block, which consists</em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment"> * of 2 bytes. This block contains both the type of reply the VCR is sending and</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment"> * the number of additional blocks of data that will follow. This may be followed</em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment"> * by a data block which can contain some anxillary information such as</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment"> * a problem with the response (if the reply is a Nack), timecode information or</em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment"> * the VCR status. Finally the VCR finished its reply with a checksum byte. After</em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment"> * setting the parts of the reply, using setCmd, setData and setChecksum, a call</em>
<a name="52" href="#52">52</a>  <em class="jxr_javadoccomment"> * to update caues the VCRReply to update he approriate state objects such as</em>
<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment"> * VCRTimecode, VCRState, and VCRError.&lt;/p&gt;</em>
<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment"> *</em>
<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment"> * @author  : $Author: hohonuuli $</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment"> * @version : $Revision: 1.4 $</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment"> */</em>
<a name="58" href="#58">58</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/mbari/vcr/rs422/VCRReply.html">VCRReply</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/mbari/vcr/VCRReplyAdapter.html">VCRReplyAdapter</a> {
<a name="59" href="#59">59</a>  
<a name="60" href="#60">60</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> &lt;!-- Field description --&gt; */</em>
<a name="61" href="#61">61</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> byte[] ACK = { 0x10, 0x01 };
<a name="62" href="#62">62</a>  
<a name="63" href="#63">63</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> &lt;!-- Field description --&gt; */</em>
<a name="64" href="#64">64</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> byte[] NACK = { 0x11, 0x12 };
<a name="65" href="#65">65</a>  
<a name="66" href="#66">66</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Corrected LTC time data */</em>
<a name="67" href="#67">67</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> byte[] OTHER_STATUS_REPLY = { 0x71, 0x20 };
<a name="68" href="#68">68</a>  
<a name="69" href="#69">69</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> &lt;!-- Field description --&gt; */</em>
<a name="70" href="#70">70</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> byte[] STATUS_REPLY = { 0x73, 0x20 };
<a name="71" href="#71">71</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(VCRReply.<strong class="jxr_keyword">class</strong>);
<a name="72" href="#72">72</a>  
<a name="73" href="#73">73</a>      <em class="jxr_javadoccomment">/**</em>
<a name="74" href="#74">74</a>  <em class="jxr_javadoccomment">         * The checksum of the command submitted to the VCR</em>
<a name="75" href="#75">75</a>  <em class="jxr_javadoccomment">         * @uml.property  name="commandChecksum" multiplicity="(0 -1)" dimension="1"</em>
<a name="76" href="#76">76</a>  <em class="jxr_javadoccomment">         */</em>
<a name="77" href="#77">77</a>      <strong class="jxr_keyword">private</strong> byte[] commandChecksum = <strong class="jxr_keyword">new</strong> byte[1];
<a name="78" href="#78">78</a>  
<a name="79" href="#79">79</a>      <em class="jxr_javadoccomment">/**</em>
<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">         * @uml.property  name="vcrStatus"</em>
<a name="81" href="#81">81</a>  <em class="jxr_javadoccomment">         * @uml.associationEnd  multiplicity="(1 1)"</em>
<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment">         */</em>
<a name="83" href="#83">83</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/mbari/vcr/rs422/VCRState.html">VCRState</a> vcrStatus = <strong class="jxr_keyword">new</strong> <a href="../../../../org/mbari/vcr/rs422/VCRState.html">VCRState</a>();
<a name="84" href="#84">84</a>  
<a name="85" href="#85">85</a>      <em class="jxr_javadoccomment">/**</em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">         * @uml.property  name="vcrTimecode"</em>
<a name="87" href="#87">87</a>  <em class="jxr_javadoccomment">         * @uml.associationEnd  multiplicity="(1 1)"</em>
<a name="88" href="#88">88</a>  <em class="jxr_javadoccomment">         */</em>
<a name="89" href="#89">89</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/mbari/vcr/rs422/VCRTimecode.html">VCRTimecode</a> vcrTimecode = <strong class="jxr_keyword">new</strong> <a href="../../../../org/mbari/vcr/rs422/VCRTimecode.html">VCRTimecode</a>();
<a name="90" href="#90">90</a>  
<a name="91" href="#91">91</a>      <em class="jxr_javadoccomment">/**</em>
<a name="92" href="#92">92</a>  <em class="jxr_javadoccomment">         * @uml.property  name="vcrError"</em>
<a name="93" href="#93">93</a>  <em class="jxr_javadoccomment">         * @uml.associationEnd  multiplicity="(1 1)"</em>
<a name="94" href="#94">94</a>  <em class="jxr_javadoccomment">         */</em>
<a name="95" href="#95">95</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/mbari/vcr/rs422/VCRError.html">VCRError</a> vcrError = <strong class="jxr_keyword">new</strong> <a href="../../../../org/mbari/vcr/rs422/VCRError.html">VCRError</a>();
<a name="96" href="#96">96</a>  
<a name="97" href="#97">97</a>      <em class="jxr_javadoccomment">/**</em>
<a name="98" href="#98">98</a>  <em class="jxr_javadoccomment">         * @uml.property  name="vcrUserbits"</em>
<a name="99" href="#99">99</a>  <em class="jxr_javadoccomment">         * @uml.associationEnd  multiplicity="(1 1)"</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">         */</em>
<a name="101" href="#101">101</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/mbari/vcr/rs422/VCRUserbits.html">VCRUserbits</a> vcrUserbits = <strong class="jxr_keyword">new</strong> <a href="../../../../org/mbari/vcr/rs422/VCRUserbits.html">VCRUserbits</a>();
<a name="102" href="#102">102</a> 
<a name="103" href="#103">103</a>     <em class="jxr_javadoccomment">/**</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment">         * @uml.property  name="checksum" multiplicity="(0 -1)" dimension="1"</em>
<a name="105" href="#105">105</a> <em class="jxr_javadoccomment">         */</em>
<a name="106" href="#106">106</a>     <strong class="jxr_keyword">private</strong> byte[] checksum;
<a name="107" href="#107">107</a> 
<a name="108" href="#108">108</a>     <em class="jxr_javadoccomment">/**</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment">         * @uml.property  name="cmd" multiplicity="(0 -1)" dimension="1"</em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment">         */</em>
<a name="111" href="#111">111</a>     <strong class="jxr_keyword">private</strong> byte[] cmd;
<a name="112" href="#112">112</a> 
<a name="113" href="#113">113</a>     <em class="jxr_javadoccomment">/**</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">         * The command submited to the VCR</em>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment">         * @uml.property  name="command" multiplicity="(0 -1)" dimension="1"</em>
<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">         */</em>
<a name="117" href="#117">117</a>     <strong class="jxr_keyword">private</strong> byte[] command;
<a name="118" href="#118">118</a> 
<a name="119" href="#119">119</a>     <em class="jxr_javadoccomment">/**</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">         * @uml.property  name="data" multiplicity="(0 -1)" dimension="1"</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">         */</em>
<a name="122" href="#122">122</a>     <strong class="jxr_keyword">private</strong> byte[] data;
<a name="123" href="#123">123</a> 
<a name="124" href="#124">124</a>     <em class="jxr_javadoccomment">/**</em>
<a name="125" href="#125">125</a> <em class="jxr_javadoccomment">     * The last byte in a command block is the checksum, i.e. the lower eight</em>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment">     * bits of the sum of the other bytes in the command block</em>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment">     * @param command The byte array to to calculate a checksum</em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment">     * @return The checksum value of the command</em>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment">     */</em>
<a name="130" href="#130">130</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> byte calculateChecksum(byte[] command) {
<a name="131" href="#131">131</a>         <strong class="jxr_keyword">int</strong> temp = 0;
<a name="132" href="#132">132</a> 
<a name="133" href="#133">133</a>         <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; command.length; i++) {
<a name="134" href="#134">134</a>             temp += command[i];
<a name="135" href="#135">135</a>         }
<a name="136" href="#136">136</a> 
<a name="137" href="#137">137</a>         <strong class="jxr_keyword">return</strong> ((byte) temp);
<a name="138" href="#138">138</a>     }
<a name="139" href="#139">139</a> 
<a name="140" href="#140">140</a>     <em class="jxr_javadoccomment">/**</em>
<a name="141" href="#141">141</a> <em class="jxr_javadoccomment">         * @return  The checksum value stored in the VCRReply</em>
<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">         * @uml.property  name="checksum"</em>
<a name="143" href="#143">143</a> <em class="jxr_javadoccomment">         */</em>
<a name="144" href="#144">144</a>     <strong class="jxr_keyword">public</strong> byte[] getChecksum() {
<a name="145" href="#145">145</a>         <strong class="jxr_keyword">return</strong> checksum;
<a name="146" href="#146">146</a>     }
<a name="147" href="#147">147</a> 
<a name="148" href="#148">148</a>     <em class="jxr_javadoccomment">/**</em>
<a name="149" href="#149">149</a> <em class="jxr_javadoccomment">         * @return  The command block of the reply</em>
<a name="150" href="#150">150</a> <em class="jxr_javadoccomment">         * @uml.property  name="cmd"</em>
<a name="151" href="#151">151</a> <em class="jxr_javadoccomment">         */</em>
<a name="152" href="#152">152</a>     <strong class="jxr_keyword">public</strong> byte[] getCmd() {
<a name="153" href="#153">153</a>         <strong class="jxr_keyword">return</strong> cmd;
<a name="154" href="#154">154</a>     }
<a name="155" href="#155">155</a> 
<a name="156" href="#156">156</a>     <em class="jxr_javadoccomment">/**</em>
<a name="157" href="#157">157</a> <em class="jxr_javadoccomment">         * @return  The Command that was sent to the VCR</em>
<a name="158" href="#158">158</a> <em class="jxr_javadoccomment">         * @uml.property  name="command"</em>
<a name="159" href="#159">159</a> <em class="jxr_javadoccomment">         */</em>
<a name="160" href="#160">160</a>     <strong class="jxr_keyword">public</strong> byte[] getCommand() {
<a name="161" href="#161">161</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.command;
<a name="162" href="#162">162</a>     }
<a name="163" href="#163">163</a> 
<a name="164" href="#164">164</a>     <em class="jxr_javadoccomment">/**</em>
<a name="165" href="#165">165</a> <em class="jxr_javadoccomment">         * @return  The checksum of the command that was sent to the VCR.</em>
<a name="166" href="#166">166</a> <em class="jxr_javadoccomment">         * @uml.property  name="commandChecksum"</em>
<a name="167" href="#167">167</a> <em class="jxr_javadoccomment">         */</em>
<a name="168" href="#168">168</a>     <strong class="jxr_keyword">public</strong> byte[] getCommandChecksum() {
<a name="169" href="#169">169</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.commandChecksum;
<a name="170" href="#170">170</a>     }
<a name="171" href="#171">171</a> 
<a name="172" href="#172">172</a>     <em class="jxr_javadoccomment">/**</em>
<a name="173" href="#173">173</a> <em class="jxr_javadoccomment">         * @return  Get the data block of the VCR reply.</em>
<a name="174" href="#174">174</a> <em class="jxr_javadoccomment">         * @uml.property  name="data"</em>
<a name="175" href="#175">175</a> <em class="jxr_javadoccomment">         */</em>
<a name="176" href="#176">176</a>     <strong class="jxr_keyword">public</strong> byte[] getData() {
<a name="177" href="#177">177</a>         <strong class="jxr_keyword">return</strong> data;
<a name="178" href="#178">178</a>     }
<a name="179" href="#179">179</a> 
<a name="180" href="#180">180</a>     <em class="jxr_javadoccomment">/**</em>
<a name="181" href="#181">181</a> <em class="jxr_javadoccomment">     * @return The error object associated with this reply</em>
<a name="182" href="#182">182</a> <em class="jxr_javadoccomment">     * @see org.mbari.vcr.VCRError</em>
<a name="183" href="#183">183</a> <em class="jxr_javadoccomment">     */</em>
<a name="184" href="#184">184</a>     @Override
<a name="185" href="#185">185</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/mbari/vcr/IVCRError.html">IVCRError</a> getVcrError() {
<a name="186" href="#186">186</a>         <strong class="jxr_keyword">return</strong> vcrError;
<a name="187" href="#187">187</a>     }
<a name="188" href="#188">188</a> 
<a name="189" href="#189">189</a>     <em class="jxr_javadoccomment">/**</em>
<a name="190" href="#190">190</a> <em class="jxr_javadoccomment">     * @return The state object associated with this reply</em>
<a name="191" href="#191">191</a> <em class="jxr_javadoccomment">     * @see org.mbari.vcr.VCRState</em>
<a name="192" href="#192">192</a> <em class="jxr_javadoccomment">     */</em>
<a name="193" href="#193">193</a>     @Override
<a name="194" href="#194">194</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/mbari/vcr/IVCRState.html">IVCRState</a> getVcrState() {
<a name="195" href="#195">195</a>         <strong class="jxr_keyword">return</strong> vcrStatus;
<a name="196" href="#196">196</a>     }
<a name="197" href="#197">197</a> 
<a name="198" href="#198">198</a>     <em class="jxr_javadoccomment">/**</em>
<a name="199" href="#199">199</a> <em class="jxr_javadoccomment">     * @return The timecode object associated with this reply</em>
<a name="200" href="#200">200</a> <em class="jxr_javadoccomment">     * @see org.mbari.vcr.VCRTimecode</em>
<a name="201" href="#201">201</a> <em class="jxr_javadoccomment">     */</em>
<a name="202" href="#202">202</a>     @Override
<a name="203" href="#203">203</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/mbari/vcr/IVCRTimecode.html">IVCRTimecode</a> getVcrTimecode() {
<a name="204" href="#204">204</a>         <strong class="jxr_keyword">return</strong> vcrTimecode;
<a name="205" href="#205">205</a>     }
<a name="206" href="#206">206</a> 
<a name="207" href="#207">207</a>     <em class="jxr_javadoccomment">/**</em>
<a name="208" href="#208">208</a> <em class="jxr_javadoccomment">     * &lt;p&gt;&lt;!-- Method description --&gt;&lt;/p&gt;</em>
<a name="209" href="#209">209</a> <em class="jxr_javadoccomment">     *</em>
<a name="210" href="#210">210</a> <em class="jxr_javadoccomment">     *</em>
<a name="211" href="#211">211</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="212" href="#212">212</a> <em class="jxr_javadoccomment">     */</em>
<a name="213" href="#213">213</a>     @Override
<a name="214" href="#214">214</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/mbari/vcr/IVCRUserbits.html">IVCRUserbits</a> getVcrUserbits() {
<a name="215" href="#215">215</a>         <strong class="jxr_keyword">return</strong> vcrUserbits;
<a name="216" href="#216">216</a>     }
<a name="217" href="#217">217</a> 
<a name="218" href="#218">218</a>     <em class="jxr_javadoccomment">/**</em>
<a name="219" href="#219">219</a> <em class="jxr_javadoccomment">     * Checks to see if the reply is an ack (acknowledgement)</em>
<a name="220" href="#220">220</a> <em class="jxr_javadoccomment">     * @return True if the reply is ACK</em>
<a name="221" href="#221">221</a> <em class="jxr_javadoccomment">     */</em>
<a name="222" href="#222">222</a>     @Override
<a name="223" href="#223">223</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isAck() {
<a name="224" href="#224">224</a>         <strong class="jxr_keyword">return</strong> (Arrays.equals(cmd, ACK));
<a name="225" href="#225">225</a>     }
<a name="226" href="#226">226</a> 
<a name="227" href="#227">227</a>     <em class="jxr_javadoccomment">/**</em>
<a name="228" href="#228">228</a> <em class="jxr_javadoccomment">     * Checks the checksum in the reply with the calculated checksum. Sets</em>
<a name="229" href="#229">229</a> <em class="jxr_javadoccomment">     * the appropriate error status in the vCRStatus object.</em>
<a name="230" href="#230">230</a> <em class="jxr_javadoccomment">     *</em>
<a name="231" href="#231">231</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="232" href="#232">232</a> <em class="jxr_javadoccomment">     */</em>
<a name="233" href="#233">233</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isChecksumOK() {
<a name="234" href="#234">234</a>         <strong class="jxr_keyword">boolean</strong> OK = <strong class="jxr_keyword">true</strong>;
<a name="235" href="#235">235</a> 
<a name="236" href="#236">236</a>         <strong class="jxr_keyword">if</strong> (cmd == <strong class="jxr_keyword">null</strong>) {
<a name="237" href="#237">237</a>             OK = false;
<a name="238" href="#238">238</a>         }
<a name="239" href="#239">239</a>         <strong class="jxr_keyword">else</strong> {
<a name="240" href="#240">240</a> 
<a name="241" href="#241">241</a>             <em class="jxr_comment">// Put the Command block recieved from the VCR into a single byte array</em>
<a name="242" href="#242">242</a>             <em class="jxr_comment">// so that we can calculate the</em>
<a name="243" href="#243">243</a>             byte[] cmdBlock;
<a name="244" href="#244">244</a> 
<a name="245" href="#245">245</a>             <strong class="jxr_keyword">if</strong> ((data == <strong class="jxr_keyword">null</strong>) || (data.length == 0)) {
<a name="246" href="#246">246</a>                 cmdBlock = <strong class="jxr_keyword">new</strong> byte[cmd.length];
<a name="247" href="#247">247</a>             }
<a name="248" href="#248">248</a>             <strong class="jxr_keyword">else</strong> {
<a name="249" href="#249">249</a>                 cmdBlock = <strong class="jxr_keyword">new</strong> byte[cmd.length + data.length];
<a name="250" href="#250">250</a>             }
<a name="251" href="#251">251</a> 
<a name="252" href="#252">252</a>             <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; cmd.length; i++) {
<a name="253" href="#253">253</a>                 cmdBlock[i] = cmd[i];
<a name="254" href="#254">254</a>             }
<a name="255" href="#255">255</a> 
<a name="256" href="#256">256</a>             <strong class="jxr_keyword">if</strong> ((data != <strong class="jxr_keyword">null</strong>) &amp;&amp; (data.length &gt; 0)) {
<a name="257" href="#257">257</a>                 <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 2; i &lt; cmdBlock.length; i++) {
<a name="258" href="#258">258</a>                     cmdBlock[i] = data[i - 2];
<a name="259" href="#259">259</a>                 }
<a name="260" href="#260">260</a>             }
<a name="261" href="#261">261</a> 
<a name="262" href="#262">262</a>             <em class="jxr_comment">// Compare the checksums</em>
<a name="263" href="#263">263</a>             byte checksum2 = calculateChecksum(cmdBlock);
<a name="264" href="#264">264</a> 
<a name="265" href="#265">265</a>             <strong class="jxr_keyword">if</strong> (checksum[0] != checksum2) {
<a name="266" href="#266">266</a>                 <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a name="267" href="#267">267</a>                     log.debug(<span class="jxr_string">"Invalid checksum. [Expected = "</span> + NumberUtilities.toHexString(<strong class="jxr_keyword">new</strong> byte[] { checksum2 }) +
<a name="268" href="#268">268</a>                               <span class="jxr_string">"] [recieved = "</span> + NumberUtilities.toHexString(checksum) + <span class="jxr_string">"]"</span>);
<a name="269" href="#269">269</a>                 }
<a name="270" href="#270">270</a> 
<a name="271" href="#271">271</a>                 vcrError.setError(VCRError.CHECKSUM_ERROR);
<a name="272" href="#272">272</a>                 OK = false;
<a name="273" href="#273">273</a>             }
<a name="274" href="#274">274</a>             <strong class="jxr_keyword">else</strong> {
<a name="275" href="#275">275</a>                 vcrError.setError(VCRError.OK);
<a name="276" href="#276">276</a>                 OK = <strong class="jxr_keyword">true</strong>;
<a name="277" href="#277">277</a>             }
<a name="278" href="#278">278</a>         }
<a name="279" href="#279">279</a> 
<a name="280" href="#280">280</a>         <strong class="jxr_keyword">return</strong> OK;
<a name="281" href="#281">281</a>     }
<a name="282" href="#282">282</a> 
<a name="283" href="#283">283</a>     <em class="jxr_javadoccomment">/**</em>
<a name="284" href="#284">284</a> <em class="jxr_javadoccomment">     * Checks to see if the reply is a nack (i.e error)</em>
<a name="285" href="#285">285</a> <em class="jxr_javadoccomment">     * @return True if the reply is NACK</em>
<a name="286" href="#286">286</a> <em class="jxr_javadoccomment">     */</em>
<a name="287" href="#287">287</a>     @Override
<a name="288" href="#288">288</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isNack() {
<a name="289" href="#289">289</a>         <strong class="jxr_keyword">return</strong> (Arrays.equals(cmd, NACK));
<a name="290" href="#290">290</a>     }
<a name="291" href="#291">291</a> 
<a name="292" href="#292">292</a>     <em class="jxr_javadoccomment">/**</em>
<a name="293" href="#293">293</a> <em class="jxr_javadoccomment">     * Checks to see if the reply is a reply to a Status sense (also called GET_STATUS</em>
<a name="294" href="#294">294</a> <em class="jxr_javadoccomment">     * @return True if he reply contains a status update</em>
<a name="295" href="#295">295</a> <em class="jxr_javadoccomment">     */</em>
<a name="296" href="#296">296</a>     @Override
<a name="297" href="#297">297</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isStatusReply() {
<a name="298" href="#298">298</a>         <strong class="jxr_keyword">return</strong> (Arrays.equals(cmd, STATUS_REPLY));
<a name="299" href="#299">299</a>     }
<a name="300" href="#300">300</a> 
<a name="301" href="#301">301</a>     <em class="jxr_javadoccomment">/**</em>
<a name="302" href="#302">302</a> <em class="jxr_javadoccomment">     * Checks to see if he reply is a response to a timecode command</em>
<a name="303" href="#303">303</a> <em class="jxr_javadoccomment">     * @return True if the reply is for a timecode</em>
<a name="304" href="#304">304</a> <em class="jxr_javadoccomment">     */</em>
<a name="305" href="#305">305</a>     @Override
<a name="306" href="#306">306</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isTimecodeReply() {
<a name="307" href="#307">307</a>         <strong class="jxr_keyword">return</strong> VCRTimecode.isTimecodeReply(cmd);
<a name="308" href="#308">308</a>     }
<a name="309" href="#309">309</a> 
<a name="310" href="#310">310</a>     <em class="jxr_javadoccomment">/**</em>
<a name="311" href="#311">311</a> <em class="jxr_javadoccomment">     * &lt;p&gt;&lt;!-- Method description --&gt;&lt;/p&gt;</em>
<a name="312" href="#312">312</a> <em class="jxr_javadoccomment">     *</em>
<a name="313" href="#313">313</a> <em class="jxr_javadoccomment">     *</em>
<a name="314" href="#314">314</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="315" href="#315">315</a> <em class="jxr_javadoccomment">     */</em>
<a name="316" href="#316">316</a>     @Override
<a name="317" href="#317">317</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isUserbitsReply() {
<a name="318" href="#318">318</a>         <strong class="jxr_keyword">return</strong> VCRUserbits.isUserbitsReply(cmd);
<a name="319" href="#319">319</a>     }
<a name="320" href="#320">320</a> 
<a name="321" href="#321">321</a>     <em class="jxr_javadoccomment">/**</em>
<a name="322" href="#322">322</a> <em class="jxr_javadoccomment">     * Update the ste objects associated with this VCRReply</em>
<a name="323" href="#323">323</a> <em class="jxr_javadoccomment">     * @param command The command that was sent to the VCR</em>
<a name="324" href="#324">324</a> <em class="jxr_javadoccomment">     * @param cmd The command portion of the VCR's reply</em>
<a name="325" href="#325">325</a> <em class="jxr_javadoccomment">     * @param data The data portion of the VCR's reply</em>
<a name="326" href="#326">326</a> <em class="jxr_javadoccomment">     * @param checksum The checksum of the VCR's reply</em>
<a name="327" href="#327">327</a> <em class="jxr_javadoccomment">     *</em>
<a name="328" href="#328">328</a> <em class="jxr_javadoccomment">     * @throws VCRException Thrown if the checksum supplied in the reply</em>
<a name="329" href="#329">329</a> <em class="jxr_javadoccomment">     * does not match the checksum calculated from the cmd and data blocks.</em>
<a name="330" href="#330">330</a> <em class="jxr_javadoccomment">     */</em>
<a name="331" href="#331">331</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> update(byte[] command, byte[] cmd, byte[] data, byte[] checksum) <strong class="jxr_keyword">throws</strong> VCRException {
<a name="332" href="#332">332</a>         <strong class="jxr_keyword">this</strong>.command = command;
<a name="333" href="#333">333</a>         <strong class="jxr_keyword">this</strong>.commandChecksum[0] = calculateChecksum(command);
<a name="334" href="#334">334</a>         <strong class="jxr_keyword">this</strong>.cmd = cmd;
<a name="335" href="#335">335</a>         <strong class="jxr_keyword">this</strong>.data = data;
<a name="336" href="#336">336</a>         <strong class="jxr_keyword">this</strong>.checksum = checksum;
<a name="337" href="#337">337</a> 
<a name="338" href="#338">338</a>         <em class="jxr_comment">// Make sure the checksum matches corectly. The VCRError for bad checksums</em>
<a name="339" href="#339">339</a>         <em class="jxr_comment">// is set in the isCheckSum OK method.</em>
<a name="340" href="#340">340</a>         <strong class="jxr_keyword">if</strong> (!isChecksumOK()) {
<a name="341" href="#341">341</a>             String nullS = <span class="jxr_string">""</span>;
<a name="342" href="#342">342</a>             <strong class="jxr_keyword">final</strong> String commandS = (command == <strong class="jxr_keyword">null</strong>) ? nullS : NumberUtilities.toHexString(command);
<a name="343" href="#343">343</a>             <strong class="jxr_keyword">final</strong> String cmdS = (cmd == <strong class="jxr_keyword">null</strong>) ? nullS : NumberUtilities.toHexString(cmd);
<a name="344" href="#344">344</a>             <strong class="jxr_keyword">final</strong> String dataS = (data == <strong class="jxr_keyword">null</strong>) ? nullS : NumberUtilities.toHexString(data);
<a name="345" href="#345">345</a>             <strong class="jxr_keyword">final</strong> String checksumS = (checksum == <strong class="jxr_keyword">null</strong>) ? nullS : NumberUtilities.toHexString(checksum);
<a name="346" href="#346">346</a> 
<a name="347" href="#347">347</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/mbari/vcr/VCRException.html">VCRException</a>(<span class="jxr_string">"Invalid checksum. [command sent = "</span> + commandS + <span class="jxr_string">"] [command recieved = "</span> + cmdS +
<a name="348" href="#348">348</a>                                    <span class="jxr_string">"] [data = "</span> + dataS + <span class="jxr_string">"] [checksum = "</span> + checksumS + <span class="jxr_string">"]"</span>);
<a name="349" href="#349">349</a>         }
<a name="350" href="#350">350</a> 
<a name="351" href="#351">351</a>         <strong class="jxr_keyword">if</strong> (isAck()) {
<a name="352" href="#352">352</a>             vcrError.setError(IVCRError.OK);
<a name="353" href="#353">353</a>         }
<a name="354" href="#354">354</a>         <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (isTimecodeReply()) {
<a name="355" href="#355">355</a> 
<a name="356" href="#356">356</a>             <em class="jxr_comment">// Handle updating the status and/or timecode as appropriate</em>
<a name="357" href="#357">357</a>             <em class="jxr_comment">// System.out.println("VCRReply.update() &lt;= setting time code");</em>
<a name="358" href="#358">358</a>             vcrTimecode.setTimecodeBytes(data);
<a name="359" href="#359">359</a>         }
<a name="360" href="#360">360</a>         <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (isUserbitsReply()) {
<a name="361" href="#361">361</a>             String bs = <span class="jxr_string">""</span>;
<a name="362" href="#362">362</a> 
<a name="363" href="#363">363</a>             <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; cmd.length; i++) {
<a name="364" href="#364">364</a>                 bs = bs + cmd[i] + <span class="jxr_string">" "</span>;
<a name="365" href="#365">365</a>             }
<a name="366" href="#366">366</a> 
<a name="367" href="#367">367</a>             <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; data.length; i++) {
<a name="368" href="#368">368</a>                 bs = bs + data[i] + <span class="jxr_string">" "</span>;
<a name="369" href="#369">369</a>             }
<a name="370" href="#370">370</a> 
<a name="371" href="#371">371</a>             <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; checksum.length; i++) {
<a name="372" href="#372">372</a>                 bs = bs + checksum[i] + <span class="jxr_string">" "</span>;
<a name="373" href="#373">373</a>             }
<a name="374" href="#374">374</a> 
<a name="375" href="#375">375</a>             <em class="jxr_comment">// System.out.println("VCRReply.update(" + bs + ")");</em>
<a name="376" href="#376">376</a>             vcrUserbits.setUserbits(data);
<a name="377" href="#377">377</a>         }
<a name="378" href="#378">378</a>         <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (isStatusReply()) {
<a name="379" href="#379">379</a>             vcrStatus.setStatus(NumberUtilities.toLong(data));
<a name="380" href="#380">380</a>         }
<a name="381" href="#381">381</a>         <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (isNack()) {
<a name="382" href="#382">382</a> 
<a name="383" href="#383">383</a>             <em class="jxr_comment">// If NACK the Reply should set the VCRError bits only</em>
<a name="384" href="#384">384</a>             <strong class="jxr_keyword">int</strong> nackData = (<strong class="jxr_keyword">int</strong>) data[0];
<a name="385" href="#385">385</a> 
<a name="386" href="#386">386</a>             vcrError.setError(nackData);
<a name="387" href="#387">387</a>         }
<a name="388" href="#388">388</a> 
<a name="389" href="#389">389</a>         notifyObservers();
<a name="390" href="#390">390</a>     }
<a name="391" href="#391">391</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

